<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="utf-8">
    <title>BasePlugin</title>
    <link rel="stylesheet" href="http://yui.yahooapis.com/3.9.1/build/cssgrids/cssgrids-min.css">
    <link rel="stylesheet" href="../assets/vendor/prettify/prettify-min.css">
    <link rel="stylesheet" href="../assets/css/main.css" id="site_styles">
    <link rel="icon" href="../assets/favicon.ico">
    <script src="http://yui.yahooapis.com/combo?3.9.1/build/yui/yui-min.js"></script>
</head>
<body class="yui3-skin-sam">

<div id="doc">
    <div id="hd" class="yui3-g header">
        <div class="yui3-u-3-4">
                <h1><img src="../assets/css/logo.png" title="" width="117" height="52"></h1>
        </div>
        <div class="yui3-u-1-4 version">
            <em>API Docs for: </em>
        </div>
    </div>
    <div id="bd" class="yui3-g">

        <div class="yui3-u-1-4">
            <div id="docs-sidebar" class="sidebar apidocs">
                <div id="api-list">
                    <h2 class="off-left">APIs</h2>
                    <div id="api-tabview" class="tabview">
                        <ul class="tabs">
                            <li><a href="#api-classes">Classes</a></li>
                            <li><a href="#api-modules">Modules</a></li>
                        </ul>
                
                        <div id="api-tabview-filter">
                            <input type="search" id="api-filter" placeholder="Type to filter APIs">
                        </div>
                
                        <div id="api-tabview-panel">
                            <ul id="api-classes" class="apis classes">
                                <li><a href="../classes/BasePlugin.html">BasePlugin</a></li>
                                <li><a href="../classes/Collection.html">Collection</a></li>
                                <li><a href="../classes/Docpad.html">Docpad</a></li>
                                <li><a href="../classes/docpadUtil.html">docpadUtil</a></li>
                                <li><a href="../classes/DocumentModel.html">DocumentModel</a></li>
                                <li><a href="../classes/ElementsCollection.html">ElementsCollection</a></li>
                                <li><a href="../classes/Events.html">Events</a></li>
                                <li><a href="../classes/FileModel.html">FileModel</a></li>
                                <li><a href="../classes/FilesCollection.html">FilesCollection</a></li>
                                <li><a href="../classes/MetaCollection.html">MetaCollection</a></li>
                                <li><a href="../classes/Model.html">Model</a></li>
                                <li><a href="../classes/PluginLoader.html">PluginLoader</a></li>
                                <li><a href="../classes/PluginTester.html">PluginTester</a></li>
                                <li><a href="../classes/QueryCollection.html">QueryCollection</a></li>
                                <li><a href="../classes/ScriptCollection.html">ScriptCollection</a></li>
                                <li><a href="../classes/ServerTester.html">ServerTester</a></li>
                                <li><a href="../classes/StylesCollection.html">StylesCollection</a></li>
                            </ul>
                
                
                            <ul id="api-modules" class="apis modules">
                            </ul>
                        </div>
                    </div>
                </div>
            </div>
        </div>
        <div class="yui3-u-3-4">
                <div id="api-options">
                    Show:
                    <label for="api-show-inherited">
                        <input type="checkbox" id="api-show-inherited" checked>
                        Inherited
                    </label>
            
                    <label for="api-show-protected">
                        <input type="checkbox" id="api-show-protected">
                        Protected
                    </label>
            
                    <label for="api-show-private">
                        <input type="checkbox" id="api-show-private">
                        Private
                    </label>
                    <label for="api-show-deprecated">
                        <input type="checkbox" id="api-show-deprecated">
                        Deprecated
                    </label>
            
                </div>
            
            <div class="apidocs">
                <div id="docs-main">
                    <div class="content">
<h1>BasePlugin Class</h1>
<div class="box meta">


        <div class="foundat">
            Defined in: <a href="../files/src_lib_plugin.coffee.html#l15"><code>src&#x2F;lib&#x2F;plugin.coffee:15</code></a>
        </div>


</div>


<div class="box intro">
    <p>The base class for all DocPad plugins</p>

</div>

    <div class="constructor">
        <h2>Constructor</h2>
<div id="method_BasePlugin" class="method item">
    <h3 class="name"><code>BasePlugin</code></h3>

        <span class="paren">()</span>








    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_plugin.coffee.html#l15"><code>src&#x2F;lib&#x2F;plugin.coffee:15</code></a>
        </p>



    </div>

    <div class="description">
        
    </div>




</div>
    </div>

<div id="classdocs" class="tabview">
    <ul class="api-class-tabs">
        <li class="api-class-tab index"><a href="#index">Index</a></li>

            <li class="api-class-tab methods"><a href="#methods">Methods</a></li>
            <li class="api-class-tab properties"><a href="#properties">Properties</a></li>
    </ul>

    <div>
        <div id="index" class="api-class-tabpanel index">
            <h2 class="off-left">Item Index</h2>

                <div class="index-section methods">
                    <h3>Methods</h3>

                    <ul class="index-list methods">
                            <li class="index-item method">
                                <a href="#method_constructor">constructor</a>

                            </li>
                            <li class="index-item method private">
                                <a href="#method_setConfig">setConfig</a>

                            </li>
                            <li class="index-item method private">
                                <a href="#method_setInstanceConfig">setInstanceConfig</a>

                            </li>
                            <li class="index-item method private">
                                <a href="#method_"></a>

                            </li>
                            <li class="index-item method private">
                                <a href="#method_addListeners">addListeners</a>

                            </li>
                            <li class="index-item method private">
                                <a href="#method_bindEvents">bindEvents</a>

                            </li>
                            <li class="index-item method private">
                                <a href="#method_bindListeners">bindListeners</a>

                            </li>
                            <li class="index-item method private">
                                <a href="#method_destroy">destroy</a>

                            </li>
                            <li class="index-item method">
                                <a href="#method_isEnabled">isEnabled</a>

                            </li>
                            <li class="index-item method private">
                                <a href="#method_removeListeners">removeListeners</a>

                            </li>
                    </ul>
                </div>

                <div class="index-section properties">
                    <h3>Properties</h3>

                    <ul class="index-list properties">
                            <li class="index-item property private">
                                <a href="#property_@extend">@extend</a>

                            </li>
                            <li class="index-item property private">
                                <a href="#property_docpad">docpad</a>

                            </li>
                            <li class="index-item property">
                                <a href="#property_"></a>

                            </li>
                            <li class="index-item property">
                                <a href="#property_"></a>

                            </li>
                            <li class="index-item property">
                                <a href="#property_"></a>

                            </li>
                            <li class="index-item property private">
                                <a href="#property_"></a>

                            </li>
                    </ul>
                </div>


        </div>

            <div id="methods" class="api-class-tabpanel">
                <h2 class="off-left">Methods</h2>

<div id="method_constructor" class="method item">
    <h3 class="name"><code>constructor</code></h3>

        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
                <li class="arg">
                        <code>opts</code>
                </li>
            </ul><span class="paren">)</span>
        </div>








    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_plugin.coffee.html#l67"><code>src&#x2F;lib&#x2F;plugin.coffee:67</code></a>
        </p>



    </div>

    <div class="description">
        <p>Constructor method for the plugin</p>

    </div>

        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
                <li class="param">
                        <code class="param-name">opts</code>
                        <span class="type">Object</span>


                    <div class="param-description">
                         
                    </div>

                </li>
            </ul>
        </div>



</div>
<div id="method_setConfig" class="method item private">
    <h3 class="name"><code>setConfig</code></h3>

        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
                <li class="arg">
                        <code class="optional">[instanceConfig=null]</code>
                </li>
            </ul><span class="paren">)</span>
        </div>



        <span class="flag private">private</span>





    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_plugin.coffee.html#l109"><code>src&#x2F;lib&#x2F;plugin.coffee:109</code></a>
        </p>



    </div>

    <div class="description">
        <p>Set Configuration</p>

    </div>

        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
                <li class="param">
                        <code class="param-name optional">[instanceConfig=null]</code>
                        <span class="type">Object</span>
                        <span class="flag optional" title="This parameter is optional.">optional</span>


                    <div class="param-description">
                         
                    </div>

                </li>
            </ul>
        </div>



</div>
<div id="method_setInstanceConfig" class="method item private">
    <h3 class="name"><code>setInstanceConfig</code></h3>

        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
                <li class="arg">
                        <code>instanceConfig</code>
                </li>
            </ul><span class="paren">)</span>
        </div>



        <span class="flag private">private</span>





    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_plugin.coffee.html#l96"><code>src&#x2F;lib&#x2F;plugin.coffee:96</code></a>
        </p>



    </div>

    <div class="description">
        <p>Set Instance Configuration</p>

    </div>

        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
                <li class="param">
                        <code class="param-name">instanceConfig</code>
                        <span class="type">Object</span>


                    <div class="param-description">
                         
                    </div>

                </li>
            </ul>
        </div>



</div>
<div id="method_" class="method item private">
    <h3 class="name"><code></code></h3>

        <span class="paren">()</span>



        <span class="flag private">private</span>





    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_plugin.coffee.html#l135"><code>src&#x2F;lib&#x2F;plugin.coffee:135</code></a>
        </p>



    </div>

    <div class="description">
        <p>Get the Configuration</p>

    </div>




</div>
<div id="method_addListeners" class="method item private">
    <h3 class="name"><code>addListeners</code></h3>

        <span class="paren">()</span>



        <span class="flag private">private</span>





    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_plugin.coffee.html#l176"><code>src&#x2F;lib&#x2F;plugin.coffee:176</code></a>
        </p>



    </div>

    <div class="description">
        <p>Add Listeners</p>

    </div>




</div>
<div id="method_bindEvents" class="method item private">
    <h3 class="name"><code>bindEvents</code></h3>

        <span class="paren">()</span>



        <span class="flag private">private</span>





    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_plugin.coffee.html#l143"><code>src&#x2F;lib&#x2F;plugin.coffee:143</code></a>
        </p>



    </div>

    <div class="description">
        <p>Alias for b/c</p>

    </div>




</div>
<div id="method_bindListeners" class="method item private">
    <h3 class="name"><code>bindListeners</code></h3>

        <span class="paren">()</span>



        <span class="flag private">private</span>





    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_plugin.coffee.html#l151"><code>src&#x2F;lib&#x2F;plugin.coffee:151</code></a>
        </p>



    </div>

    <div class="description">
        <p>Bind Listeners</p>

    </div>




</div>
<div id="method_destroy" class="method item private">
    <h3 class="name"><code>destroy</code></h3>

        <span class="paren">()</span>



        <span class="flag private">private</span>





    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_plugin.coffee.html#l233"><code>src&#x2F;lib&#x2F;plugin.coffee:233</code></a>
        </p>



    </div>

    <div class="description">
        <p>Destructor. Calls removeListeners</p>

    </div>




</div>
<div id="method_isEnabled" class="method item">
    <h3 class="name"><code>isEnabled</code></h3>

        <span class="paren">()</span>

        <span class="returns-inline">
            <span class="type">Boolean</span>
        </span>







    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_plugin.coffee.html#l243"><code>src&#x2F;lib&#x2F;plugin.coffee:243</code></a>
        </p>



    </div>

    <div class="description">
        <p>Is Enabled?</p>

    </div>


        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                        <span class="type">Boolean</span>:
            </div>
        </div>


</div>
<div id="method_removeListeners" class="method item private">
    <h3 class="name"><code>removeListeners</code></h3>

        <span class="paren">()</span>



        <span class="flag private">private</span>





    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_plugin.coffee.html#l209"><code>src&#x2F;lib&#x2F;plugin.coffee:209</code></a>
        </p>



    </div>

    <div class="description">
        <p>Remove Listeners</p>

    </div>




</div>
            </div>

            <div id="properties" class="api-class-tabpanel">
                <h2 class="off-left">Properties</h2>

<div id="property_@extend" class="property item private">
    <h3 class="name"><code>@extend</code></h3>
    <span class="type">Object</span>


        <span class="flag private">private</span>



    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_plugin.coffee.html#l22"><code>src&#x2F;lib&#x2F;plugin.coffee:22</code></a>
        </p>


    </div>

    <div class="description">
        <p>Add support for BasePlugin.extend(proto)</p>

    </div>



</div>
<div id="property_docpad" class="property item private">
    <h3 class="name"><code>docpad</code></h3>
    <span class="type">Object</span>


        <span class="flag private">private</span>



    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_plugin.coffee.html#l32"><code>src&#x2F;lib&#x2F;plugin.coffee:32</code></a>
        </p>


    </div>

    <div class="description">
        <p>The DocPad Instance</p>

    </div>



</div>
<div id="property_" class="property item">
    <h3 class="name"><code></code></h3>
    <span class="type">String</span>





    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_plugin.coffee.html#l42"><code>src&#x2F;lib&#x2F;plugin.coffee:42</code></a>
        </p>


    </div>

    <div class="description">
        <p>The plugin name</p>

    </div>



</div>
<div id="property_" class="property item">
    <h3 class="name"><code></code></h3>
    <span class="type">Object</span>





    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_plugin.coffee.html#l48"><code>src&#x2F;lib&#x2F;plugin.coffee:48</code></a>
        </p>


    </div>

    <div class="description">
        <p>The plugin config</p>

    </div>



</div>
<div id="property_" class="property item">
    <h3 class="name"><code></code></h3>
    <span class="type">Object</span>





    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_plugin.coffee.html#l54"><code>src&#x2F;lib&#x2F;plugin.coffee:54</code></a>
        </p>


    </div>

    <div class="description">
        <p>The instance config.</p>

    </div>



</div>
<div id="property_" class="property item private">
    <h3 class="name"><code></code></h3>
    <span class="type">Number</span>


        <span class="flag private">private</span>



    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_plugin.coffee.html#l60"><code>src&#x2F;lib&#x2F;plugin.coffee:60</code></a>
        </p>


    </div>

    <div class="description">
        <p>Plugin priority</p>

    </div>



</div>
            </div>


    </div>
</div>
                    </div>
                </div>
            </div>
        </div>
    </div>
</div>
<script src="../assets/vendor/prettify/prettify-min.js"></script>
<script>prettyPrint();</script>
<script src="../assets/js/yui-prettify.js"></script>
<script src="../assets/../api.js"></script>
<script src="../assets/js/api-filter.js"></script>
<script src="../assets/js/api-list.js"></script>
<script src="../assets/js/api-search.js"></script>
<script src="../assets/js/apidocs.js"></script>
</body>
</html>
